package com.xinyirun.scm.framework.base.swagger.v1;

public class Description {
//    swagger2使用说明：
//    @Api：用在类上，说明该类的作用
//    @ApiOperation：用在方法上，说明方法的作用
//    @ApiImplicitParams：用在方法上包含一组参数说明
//    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
//    paramType：参数放在哪个地方
//    header-->请求参数的获取：@RequestHeader
//    query-->请求参数的获取：@RequestParam
//    path（用于restful接口）-->请求参数的获取：@PathVariable
//    body（不常用）
//    form（不常用）
//    name：参数名
//    dataType：参数类型
//    required：参数是否必须传
//    value：参数的意思
//    defaultValue：参数的默认值
//    @ApiResponses：用于表示一组响应
//    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
//    code：数字，例如400
//    message：信息，例如"请求参数没填好"
//    response：抛出异常的类
//    @ApiModel：说明一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行说明的时候）
//    // @ApiModelProperty：说明一个model的属性
}
